dxp-ux

(0 reviews)

[GET] Fetch Account Properties

This operation retrieves the properties associated to a billing account number from Liberate.

http://[localhost]:[port]/dxp-ux/v1/{businessId}/accounts/{accountNo}/properties

name	type	description	required
businessId	string	2 letter ISO 3166 country code (PA) identifying the business unit.	Y (PA)
accountNo	string	billing account number	Y (PA)

name	type	description	required
client_id	string	The client_id identifying the channel.	Y (PA)
client_secret	string	Password associated with the client_id.	Y (PA)
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y (PA)

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
propertyType	string	Type of property being fetch; Must be 'A'	Y (PA)

field name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
accountProperties	object	properties associated to a billing account number	Y (PA)
accountProperties.a00NoOfPde	string	Number of account level properties	Y (PA)
accountProperties.a00NoOfPde.propertiesGroup[]	array	Details about the account properties	N (PA)
accountProperties.a00NoOfPde.propertiesGroup[].pdePropertyName	string	Name of the property	N (PA)
accountProperties.a00NoOfPde.propertiesGroup[].pdePropertyId	string	Id of the property	N (PA)
accountProperties.a00NoOfPde.propertiesGroup[].aspPropertyValue	string	Value of the property	N (PA)
accountProperties.a00NoOfPde.propertiesGroup[].aspStartTimeStamp	string	start time from which the property is applicable for the billingAccount	N (PA)

accountProperties.a00NoOfPde.propertiesGroup[] subResource DataModel:

field name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	example
pdePropertyName	string	Name of the property	N (PA)	PA: "pdePropertyName": "Disney plus Entitlementid"
pdePropertyId	string	Id of the property	N (PA)	PA: "pdePropertyId": "DISNEY_ENTITLEMENTID"
aspPropertyValue	string	Value of the property	N (PA)	PA: "aspPropertyValue": "0a04ba6c-8fc3-4db4-b9d6-64db0a32051a"
aspStartTimeStamp	string	start time from which the property is applicable for the billingAccount	N (PA)	PA: "aspStartTimeStamp": "13-Sep-2024 14:43:41"

The 'propertyType' input query parameter should be "A" to fetch account level properties from Liberate.
The list of accountProperties.a00NoOfPde.propertiesGroup[] in the response is based on the accountProperties.a00NoOfPde i.e., number of account level properties associated with the given billing account number.
Please refer the responses in following URL DXP UX API - fetch AccountProperties